Copyright: Copyright c 1992-1994, Sanjay Kanade


A referenced topic

The text here will be presented in a popup window when referenced from Topic name 1.


Contents

Read this topic first

Read me first

Example of bold and italic text

Example of indentations

WhizNotes list commands

Examples of conditional help generation

Sample topics

Topic name 1

Topic name 2

Since we created this "Contents" topic, it will become the contents of the generated help. If such a topic is not present then WhizNotes will create a contents for you; but the topic names will be inserted in the order that they appear in the List Of Topics. By making our own contents we get the flexibility to format it the way we want it.

If you want to see the default contents created by WhizNotes just delete this topic and then create help.


Example of bold and italic text

You can have a whole paragraph stand out as bold if you want. For example, take a look at this one.

Or, you can insert bold text anywhere in your documentation.

Italics work in a similar fashion.

You can have a whole paragraph stand out as italic if you want. For example, take a look at this one.

Or, you can insert italic and bold text anywhere in your documentation.

WhizNotes command like ~BOLD ... are case insensitive as you can see by the last example.


Example of indentations

You can indent all the following text one step by using the ~INDENT commands.

For example, the following two paragraphs are indented one step:

This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph.

This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph.

Next paragraph is indented one step further.

This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph. This is a sentence of a paragraph.

Now we go back one step.

This paragraph is at the same indentation level as the first two.

If you want to reset indent to the default value, which is no indent, at any time, then just use a 0 (zero) instead of + or -.

So we are back to the original indentation level.

Please note that an indent command has to be on a separate line by itself. It can not be embedded.

If you want to use indentation for creating bulleted lists then do not use this command. It is easier for you to manage bulleted lists and lists within lists by WhizNotes list commands.


Examples of conditional help generation

This paragraph will appear only if tag "demo" is present.

This line is not enclosed in any of the above statements so it is not affected by tags.

Here is an example of embedded tag statement: This is a demo version.


Read me first

This is a sample WhizNote file to demonstrate the use of WhizNotes commands to enhance your help text.

HOW TO USE THIS HELP FILE:

First, read the discussion of WhizNotes commands in the Main WhizNotes help topic "More help generation commands".

Then create help by selecting the menu "Tools - create help". You can look at the topics in the generated help file to see how they are formatted. Do your own expermentation and you are ready to go.

A NOTE ON PARAGRAPHS:

You must understand that in order to create effective help you must have the word wrap feature checked-on (which is the default). Do not press returns in the middle of your paragraphs. Let them wrap around the boundaries of the window.

AN EXERCISE FOR YOU:

This topic was purposely left unformatted. After understanding WhizNotes commands in the rest of the topics, try the following steps to change the generated help for this file:

Make the subtitles in this topic bold. They are currently all CAPS.

Convert the discussion "How to use this sample file" above into a bulleted list.


Topic name 1

This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence.

Please also see Topic name 2. <- This jump statement was created by dragging "Topic name 2" from the WhizNote window on to this topic. You could have typed it in instead of dragging.

What follows is an example of a reference statement. Please see A referenced topic. <- this popup behaviour appears when you choose to insert a reference instead of a Jump.


Topic name 2

This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence.

This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence. This is a test sentence.


WhizNotes list commands

WhizNotes list commands are very convenient. To start a bulleted list, all you do is to specify ~STARTLIST on a separate line by itself.

Then before each item use ~ITEM command. Note that your items can be as large as you want. Even one or more paragraphs.

Finally when you want to end the list, use the command ~ENDLIST.

Here is an example of a bulleted list:

•	This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item.

This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item. This is the first item.

•	This is the second item.

•	This is a numeric list within a list.

1.	Inner list item 1.

2.	Inner list item 2.

•	Last item of the original list.